Withdraw funds

POST /api/v1/Transactions/withdraw

Description

This endpoint is used to withdraw funds from an account.

Tags: Transactions
URL: /api/v{version}/Transactions/withdraw
ApiKey: No API key required
Content-Type: text/plain, application/json, text/json
Parameters:

• version: string, required

• Accept-Language: header, optional, change the default response message language from English(en) to French(fr) or English(en)

Body Parameters:

• AccountNumber: string, required, the account to withdraw from

• Amount: number, required, the amount to withdraw

• Currency: string, required, the currency of the withdrawal

• TransactionRef: string, required, the reference of the withdrawal

Response:

• Success, returns a DebitTransactionResponseResponse.
  Error Codes:

• 400: Bad Request

• 404: Not Found

Example:
JSON

POST /api/v1/Transactions/withdraw
{
  "AccountNumber": "123456789012",
  "Amount": 100.00,
  "Currency": "USD",
  "TransactionRef": "123456"
}

Plain Text

HTTP/1.1 200 OK
{
  "Message": "Withdrawal successful",
  "AccountNumber": "123456789012",
  "Amount": 100.00,
  "Currency": "USD",
  "TransactionRef": "123456"
}

/api/v1/Transactions/withdraw

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "debitAccountNumber": `<string>`,
  "amount": `<double>`,
  "reference": `<string>`,
  "narration": `<string>`,
  "fee": `<double>`,
  "recipientName": `<string>`,
  "recipientBank": `<string>`,
  "recipientAccountNumber": `<string>`
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "amount": `<double>`,
    "fee": `<double>`,
    "currency": `<string>`,
    "status": `<string>`,
    "reference": `<string>`,
    "narration": `<string>`,
    "trnxId": `<uuid>`
  }
}

Response: 400

{
  "succeeded": `<string>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 404

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}